GetSearchResultsFilteredPaged (Method)

Request (GetSearchResultsFilteredPagedSoapIn)

The request body is of type GetSearchResultsFilteredPaged.

Request Body Parameters

Name	Description	Data Type
SearchString		xml:string
SearchCategoryID		xml:string
IncludeItemsFromAllChildCategories		xml:boolean
IncludeModels		xml:boolean
IncludeStockCodes		xml:boolean
IncludeSKUs		xml:boolean
RowsPerPage		xml:int
PageNumber		xml:int
Filters		xml:string

Example

Javascript

// Example 1: Get filtered search results, paged 
//      for the characteristic path Specifications/SIZE
//      with a charactersitic value of 'Extra Small'

MakeAJAXCall('Inventory.GetSearchResultsFilteredPaged', {
    SearchString: '',
    SearchCategoryID: PAGE_CATEGORY,
    IncludeItemsFromAllChildCategories: true,
    IncludeModels: false,
    IncludeStockCodes: true,
    IncludeSKUs: false, 
    RowsPerPage: 12, 
    PageNumber: 1,
    Filters: JSON.stringify([{
        Path: 'Specifications/SIZE',
        Value: 'Extra Small;'
    }])
}, console.log)

200 Response (GetSearchResultsFilteredPagedSoapOut)

The response body is of type GetSearchResultsFilteredPagedResponse.

Response Body Parameters

Name	Description	Data Type
GetSearchResultsFilteredPagedResult	Example { "Data": [{ "RowNumber": 1, "Item_ID": 580, "StockCode": "A101", "Name": "15 Speed Mountain Bike Girls", "Headline": "Rulon LR Sleeve Bearing", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 11584, "LongDescription2": "Distribution/Foreign Price Eur", "ITM_Item.SortOrder": 1, "CanAddToCart": true }, { "RowNumber": 2, "Item_ID": 579, "StockCode": "A100", "Name": "Boys 15 Speed Mountain Bike", "Headline": "Rulon LR Sleeve Bearing", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 11410, "LongDescription2": "Distribution", "ITM_Item.SortOrder": 2, "CanAddToCart": true }, { "RowNumber": 3, "Item_ID": 590, "StockCode": "A103", "Name": "15 Speed Mountain Bike Men", "Headline": "Rulon LR Sleeve Bearing", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 470, "LongDescription2": "Distribution", "ITM_Item.SortOrder": 3, "CanAddToCart": true }, { "RowNumber": 4, "Item_ID": 581, "StockCode": "A102", "Name": "15\u0027 Speed Mountain Bike Ladies", "Headline": "Rulon LR Sleeve Bearing", "SubHeadline": "", "ShortDescription": "", "Link1": "", "Model_ID": 0, "SortOrder": 12226, "LongDescription2": "Distribution", "ITM_Item.SortOrder": 4, "CanAddToCart": true }], "Paging": { "CurrentPage": 1, "TotalPages": 1, "TotalResults": 4, "ResultsPerPage": 12 } }	xml:string

Name

Description

Data Type

GetSearchResultsFilteredPagedResult

Example

{
    "Data": [{
        "RowNumber": 1,
        "Item_ID": 580,
        "StockCode": "A101",
        "Name": "15 Speed Mountain Bike Girls",
        "Headline": "Rulon LR Sleeve Bearing",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 11584,
        "LongDescription2": "Distribution/Foreign Price Eur",
        "ITM_Item.SortOrder": 1,
        "CanAddToCart": true
    }, {
        "RowNumber": 2,
        "Item_ID": 579,
        "StockCode": "A100",
        "Name": "Boys 15 Speed Mountain Bike",
        "Headline": "Rulon LR Sleeve Bearing",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 11410,
        "LongDescription2": "Distribution",
        "ITM_Item.SortOrder": 2,
        "CanAddToCart": true
    }, {
        "RowNumber": 3,
        "Item_ID": 590,
        "StockCode": "A103",
        "Name": "15 Speed Mountain Bike Men",
        "Headline": "Rulon LR Sleeve Bearing",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 470,
        "LongDescription2": "Distribution",
        "ITM_Item.SortOrder": 3,
        "CanAddToCart": true
    }, {
        "RowNumber": 4,
        "Item_ID": 581,
        "StockCode": "A102",
        "Name": "15\u0027 Speed Mountain Bike Ladies",
        "Headline": "Rulon LR Sleeve Bearing",
        "SubHeadline": "",
        "ShortDescription": "",
        "Link1": "",
        "Model_ID": 0,
        "SortOrder": 12226,
        "LongDescription2": "Distribution",
        "ITM_Item.SortOrder": 4,
        "CanAddToCart": true
    }],
    "Paging": {
        "CurrentPage": 1,
        "TotalPages": 1,
        "TotalResults": 4,
        "ResultsPerPage": 12
    }
}

xml:string